home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / rss_100.zip / RSS.DOC next >
Text File  |  1991-03-23  |  14KB  |  324 lines
  1.  
  2.  
  3.  
  4.                          RemoteAccess System Statistics
  5.  
  6.                                   Version 1.00
  7.  
  8.  
  9.  
  10.                 A Configurable User/System Statistics Generator
  11.  
  12.                              For RemoteAccess 1.00
  13.  
  14.  
  15.  
  16.                    (c) Copyright 1991, by Kenneth R. Doebler
  17.                               All Rights Reserved
  18.  
  19.  
  20.  
  21.  
  22.                               Released on 3/23/91
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.        DISCLAIMER:
  32.  
  33.        "RSS is supplied as is.  The author disclaims all warrantees,
  34.        expressed or implied, including, without limitation, the
  35.        warrantees of merchantability and of fitness for any purpose.
  36.        The author assumes no liability for damages, direct or
  37.        consequential, which may result from the use of RSS."
  38.  
  39.  
  40.        DISTRIBUTION:
  41.  
  42.        RSS is distributed in archived form.  The distribution archive
  43.        should contain the following files:
  44.  
  45.  
  46.                    RSS      EXE    46315   3-23-91   1:00a
  47.                    RSS      DOC    14204   3-23-91   1:00a
  48.                    SOFTRES  DOC     1579   3-23-91   1:00a
  49.  
  50.  
  51.        If your distribution archive is missing any of these files, or if
  52.        any of your files are different from the above list, you do not
  53.        have an original distribution archive.  Please contact me at the
  54.        address or number listed at the end of this document.  You may
  55.        obtain the latest official distribution archive at any time from
  56.        The Software Resource, listed at the end of this document.
  57.  
  58.        You are encouraged to pass a copy of RSS along to your friends or
  59.        post it on Bulletin Boards for downloading, provided that you:
  60.  
  61.           1)  Do not modify or alter the original program or
  62.               documentation files in any way.
  63.  
  64.           2)  Pass along the complete archive with all files included,
  65.               in it's original unmodified form.
  66.  
  67.           3)  Do not distribute the archive in conjunction with any
  68.               commercial or money making endeavor of any kind without
  69.               prior consent of the author.
  70.  
  71.        If you are in doubt about the contents of your distribution
  72.        archive or any of the above items, please contact me via netmail
  73.        or call The Software Resource at the address and number listed at
  74.        the end of this document.
  75.  
  76.  
  77.        ONWARD:
  78.  
  79.        RSS is a utility for use with RemoteAccess 1.00.  RSS will read
  80.        your Users.Bbs file and generate a screen of statistics that can
  81.        be displayed using RA's Type 5 menu command, or any of the other
  82.        functions which display an ANS/ASC file.  Sorry, no AVT files
  83.        yet.. I have no idea how to generate AVATAR files, however,
  84.        someone was nice enough to forward some info on AVATAR, so I may
  85.        be able to include this in future releases.
  86.  
  87.        This is the first official public release of RSS.  It has been
  88.        tested on several systems running RemoteAccess 1.00 with good
  89.        results and should work as expected.  Every effort has been made
  90.        to find and eliminate all bugs in the testing process.
  91.  
  92.        RSS will not harm or modify any of your RA system files in
  93.        any way, so you may use it without fear of possible dire results.
  94.  
  95.        RSS is a snap to set up and use.  Please give the sections below
  96.        a quick browse for details.
  97.  
  98.  
  99.        What does RSS do?
  100.  
  101.        RSS is basically a User/System statistics generator.  RSS will
  102.        read your Users.Bbs file and generate a report screen which can
  103.        then be displayed online via RA's Type 5 or similar menu command.
  104.        The report screens generated look something like the following:
  105.  
  106.  
  107.           RemoteAccess System Statistics for [Your System Name]
  108.  
  109.        Total system calls ................................... xxxx
  110.        Total number of users ................................. xxx
  111.        Total messages posted ................................. xxx
  112.        Total downloads ....................................... xxx 
  113.        Total download kbytes ............................... xxxxx
  114.        Total uploads ......................................... xxx
  115.        Total upload kbytes .................................. xxxx
  116.  
  117.        Average calls per user ................................. xx
  118.        Average time used per call ............................. xx
  119.        Average messages posted per user ....................... xx
  120.        Average user security level ............................ xx
  121.        Average downloads per user ............................. xx
  122.        Average download kbytes per user ...................... xxx
  123.        Average uploads per user ............................... xx 
  124.        Average upload kbytes per user ........................ xxx
  125.  
  126.  
  127.        Press [Enter] To Continue:
  128.  
  129.        
  130.        RSS automatically excludes the Sysop (or User Record #0) from the
  131.        summary of stats.  If your Sysop User Record is anything like
  132.        mine, it would render the stats useless. :)
  133.  
  134.        In order to make RSS more configurable for individual Sysops, I
  135.        have included a Configuration Menu within RSS which will allow
  136.        you to select which statistics are displayed and which are not.
  137.        You may also enable/disable the screen clearing codes and prompt
  138.        lines via the config menu as well as select the colors used in
  139.        the .ANS screen generated by RSS.
  140.  
  141.        Including the configuration code within the main program resulted
  142.        in extra overhead for the RSS.EXE file, however, this seemed to
  143.        be the best choice for overall efficiency and easy of use.  I
  144.        prefer keeping the RSS distribution archive as small as possible,
  145.        and adding a separate configuration program would have increased
  146.        it's size substantially.
  147.  
  148.        RSS will generate one .ANS and one .ASC file, with a screen
  149.        clearing code at the top of each, and the prompt "Press [Enter]
  150.        To Continue: " at the bottom by default.  A default set of colors
  151.        is also used in the .ANS file.  The .ANS/.ASC files generated
  152.        will automatically be placed in your \TXTFILES directory as
  153.        defined in CONFIG.RA.  Look for the text files RSS.ANS and
  154.        RSS.ASC in this directory after you run RSS.
  155.  
  156.        RSS will not harm any of your RA system files in any way.  I
  157.        repeat this for anyone who may be wondering about potential
  158.        dangers to your RA files.  RSS only reads the RA system files,
  159.        and does no writing to those files whatsoever.  Isn't that a
  160.        relief!
  161.  
  162.  
  163.        What does RSS need to run?
  164.  
  165.        RSS.EXE would typically be run from your main RA system directory
  166.        (\RA), however, you can run it from just about anywhere if you
  167.        have your RA environment variable set (RA=Drive:\Path).  RSS will
  168.        read the DOS environment and search for the "RA=Drive:\Path" info
  169.        to find out where your RA system files are located.  If you have
  170.        the path that holds RSS.EXE in your DOS search PATH line, you can
  171.        execute RSS from any directory or drive.
  172.  
  173.        RSS will first attempt to find your RA path information in the
  174.        environment, and if it finds nothing there (no "RA=xxx"), it will
  175.        search the current directory for your RA system files.  If you do
  176.        not set your RA environment variable, or if you're in doubt about
  177.        all this, the simplest thing to do is place RSS.EXE in your main
  178.        RA system directory (\RA) and run it from there.
  179.  
  180.        RSS reads CONFIG.RA to obtain the paths to your Users.BBS file
  181.        and your TextFiles (*.ANS/ASC).  RSS also grabs your System Name
  182.        from the CONFIG.RA file for use in the screens it creates.
  183.  
  184.        RSS also takes a quick peek at SysInfo.Bbs to grab the total
  185.        system calls number.  RSS will use the total calls found in
  186.        SysInfo.Bbs for the Total System Calls display line, however, RSS
  187.        will use the sum of all the active user's calls for calculating
  188.        the averages.. i.e., Average Calls Per User, and so on.
  189.  
  190.        If the file RSS.CFG exists in your RA system directory (\RA),
  191.        then RSS will also read it's configuration information from this
  192.        file when it fires up.
  193.  
  194.        In a nutshell:  RSS can be run from any directory or drive as
  195.        long as you set your RA environment variable (RA=Drive:\Path).
  196.        If you're in doubt about how to do this, please see your RA docs
  197.        or simply run RSS from your main RA system directory (\RA).
  198.        That's about it.
  199.  
  200.  
  201.        How do I set up RSS?
  202.  
  203.        The first time you run RSS, you should run it with the "-c"
  204.        command line option, or "RSS -c".  This will bring up RSS's
  205.        Configuration Menu and create a file called RSS.CFG in your
  206.        RA system directory (\RA\).  The Configuration Menu should
  207.        be self-explanatory.
  208.  
  209.        The "-c" Configure RSS option will allow you to control what
  210.        statistics RSS reports and which ones it leaves out.  Handy for
  211.        suppressing those potentially embarrasing ones like Average
  212.        Upload Kbytes Per User!  Simply toggle the items you wish to
  213.        include/exclude in the statistics screens and exit.  RSS will
  214.        automatically save the changes if any were made.
  215.  
  216.        The "-c" Configure RSS option also allows you to specify whether
  217.        you want RSS to put screen clearing codes in the .ANS/ASC files
  218.        it generates.  In addition, you may tell RSS to include the
  219.        prompt line "Press [Enter] To Continue: " in your screens or
  220.        exclude it if you like.  These two options should make it easier
  221.        to use some of the other RA display commands, rather than just
  222.        Type 5 only.
  223.  
  224.        And, as a final touch, the "-c" Configure RSS option also allows
  225.        you to configure the colors which RSS will use in generating the
  226.        RSS.ANS screen file.  This will let you configure RSS to fit in
  227.        with your overall color scheme.
  228.  
  229.        If you do not run RSS with the "-c" option, no RSS.CFG file
  230.        will ever be generated, and RSS will default to displaying all
  231.        statistics as well as including screen clearing codes and prompt
  232.        lines.  A default set of colors will also be used in the .ANS
  233.        screen.
  234.  
  235.        You'll need to set up a menu type 5 command (Display ANS/ASC
  236.        File) in one of your menus to display the output files created by
  237.        RSS.  You can use any of the RA display commands you like,
  238.        however, it seems to be easiest to use a type 5 and simply put
  239.        the file name "RSS" in the Optional Data field.  I have a menu
  240.        option called "E)xtra Info" on my main menu for displaying the
  241.        RSS stats screen.
  242.  
  243.  
  244.        How do I run RSS?
  245.  
  246.        To run RSS, just type "RSS".  RSS can be run as part of your
  247.        batch file after each caller logs off, or alternately, during
  248.        your nightly maintenance.  RSS should be fast enough to run after
  249.        each caller, but if you prefer, it can be run once a day.
  250.  
  251.        Note:  Needless to say, do not run RSS with the "-c" command line
  252.        option from your batch file or RSS will sit there patiently
  253.        waiting for you to do something.
  254.  
  255.  
  256.        What else is there to know?
  257.  
  258.        Well, there isn't much else to it!  RSS is a pretty simple
  259.        program for RA and it's something that I created while playing
  260.        with the BBS here and browsing thru the RASTRUCT information.  I
  261.        wanted something like this for my system to display general User
  262.        stats and I thought some other Sysops running RA might enjoy it
  263.        also.  It's mostly just for fun!
  264.  
  265.        I have avoided putting any kind of "advertising" or annoying junk
  266.        in the display screens created by RSS.  I personally dislike
  267.        seeing all kinds of crud in screens created by RA utilities, and
  268.        I think most other Sysops can easily live without it also.  If
  269.        people want to know where an RA utility came from, they can
  270.        easily ask the Sysop and find out.  That's just my personal
  271.        feeling on this, so I've left RSS "clean" and free of "plugs".
  272.  
  273.        RSS is free to anyone interested in using it.  No registration,
  274.        no fees, nothing..  If you like it, and enjoy using it, that's
  275.        great.  Send me a note via netmail and tell me you like it.  It'd
  276.        make me feel good.  If you don't like it, and don't wish to use
  277.        it, that's fine also.. I can sympathize with you.  There's
  278.        nothing worse than disliking a BBS utility and forcing yourself
  279.        to use it anyway.  I have tried to make RSS as configurable as
  280.        possible and hopefully some of you will enjoy using RSS.
  281.  
  282.  
  283.        RSS was written and compiled using Microsoft's BASIC 7.1 PDS
  284.        (Professional Development System) with a little additional help
  285.        from Microsoft's MASM 5.1.
  286.  
  287.  
  288.        My special thanks to those who helped in the beta testing of RSS,
  289.        and who have provided suggestions, bug reports and other helpful
  290.        comments on RSS:
  291.  
  292.        David Boehm       The General Store            Fidonet 1:102/134
  293.        Basil Groman      Branson's Remote Access      Fidonet 1:284/100
  294.        Mike Janke        Kendall BBS                  Fidonet 1:135/4
  295.        Gary Vedvik       The Library                  Fidonet 1:102/1006
  296.  
  297.  
  298.        Please check RSS out and see how it works on your system.  If you
  299.        find any bugs please let me know via netmail or on the BBS.  If
  300.        you have any ideas or suggestions for improving RSS, I'd like to
  301.        hear about them also.  I can't commit much of my time to working
  302.        on BBS utilities, but I would like to do so as long as it remains
  303.        "just for fun".
  304.  
  305.        Thanks, and enjoy..
  306.  
  307.        Ken
  308.  
  309.  
  310.        The Software Resource
  311.        24 Hours A Day
  312.        1200-2400 bps
  313.        (213) 214-2018
  314.  
  315.        Fidonet Address: 1:102/330
  316.        Torrance, California
  317.  
  318.  
  319.        And finally..
  320.  
  321.        BASIC PDS and MASM are (c) Copyright Microsoft Corporation,
  322.        1981-1990.
  323.  
  324.